Skip to content

Add release operator checklist - #425

Open
Alek99 wants to merge 3 commits into
mainfrom
agent/add-release-checklist
Open

Add release operator checklist#425
Alek99 wants to merge 3 commits into
mainfrom
agent/add-release-checklist

Conversation

@Alek99

@Alek99 Alek99 commented Aug 2, 2026

Copy link
Copy Markdown
Member

Summary

  • add an ordered release operator checklist for xy and the bundled reflex_xy integration
  • document version/tag safety, Rust-backed and coreless sdist validation, release monitoring, clean-install smoke tests, and recovery paths
  • add a Remotion release-video and LinkedIn thumbnail brief with verified-content, visual, delivery, QA, and explicit approval requirements
  • link the checklist from the contributor and production-readiness documentation

Why

The production-readiness spec captures release invariants, but maintainers also need an end-to-end operating procedure. This records the lessons from the 0.0.5 release, especially PyPI immutability, Rust/native verification, optional Reflex boundaries, testing the published package from a clean environment, and preparing accurate release media without publishing before approval.

Impact

Documentation only. Release maintainers get a repeatable release and media-production path without changes to package or workflow behavior.

Validation

  • uv run --with pre-commit pre-commit run --all-files
  • uv run ruff check .
  • uv run ruff format --check .
  • .venv/bin/python scripts/verify_local.py --only examples — 9 passed, 2 skipped
  • git diff --cached --check

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive release-operator checklist covering version selection, packaging, tagging, publication, monitoring, validation, media production, recovery, and final sign-off.
    • Documented checks for package immutability, tag recovery, native and coreless source distributions, clean-install smoke tests, and published-package examples.
    • Updated contribution guidance to reference the release checklist and production-readiness requirements.

@coderabbitai

coderabbitai Bot commented Aug 2, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f178a935-f211-4b20-a80c-7a63138ec37b

📥 Commits

Reviewing files that changed from the base of the PR and between 48c934b and 4deed6c.

📒 Files selected for processing (1)
  • spec/process/release-checklist.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • spec/process/release-checklist.md

📝 Walkthrough

Walkthrough

The PR adds an ordered release-operator checklist. It covers preparation, artifact validation, publication, clean-install checks, release media, recovery procedures, and final sign-off. Contributor and production-readiness documents reference the checklist.

Changes

Release process

Layer / File(s) Summary
Release preparation and artifact validation
spec/process/release-checklist.md
Defines release scope, version and tag checks, workflow dry runs, merge verification, and native and coreless sdist validation.
Publication and clean-install verification
spec/process/release-checklist.md
Defines GitHub and PyPI publication checks, release-job monitoring, clean-environment verification, and published-package example tests.
Media, recovery, final sign-off, and process links
spec/process/release-checklist.md, CONTRIBUTING.md, spec/process/production-readiness.md
Defines release-media requirements, recovery procedures, final sign-off checks, and references to the release-operator checklist.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • reflex-dev/xy#275: The checklist documents tag-based versioning and artifact verification.
  • reflex-dev/xy#421: The checklist supports the release preparation and tagging workflow.
  • reflex-dev/xy#422: The checklist includes native and coreless sdist validation and recovery procedures.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the pull request's main change: adding a release operator checklist.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/add-release-checklist

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codspeed-hq

codspeed-hq Bot commented Aug 2, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 109 untouched benchmarks
⏩ 2 skipped benchmarks1


Comparing agent/add-release-checklist (4deed6c) with main (b3e2605)

Open in CodSpeed

Footnotes

  1. 2 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@Alek99
Alek99 force-pushed the agent/add-release-checklist branch from 9577020 to 48c934b Compare August 7, 2026 18:32
@Alek99
Alek99 marked this pull request as ready for review August 7, 2026 18:32

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@spec/process/release-checklist.md`:
- Around line 84-91: Update the coreless import check in the release checklist
so CI verifies that importing xy and reflex_xy does not eagerly load NumPy,
Reflex, or the native core, while retaining the assertion that requesting
compute raises the documented native-core ImportError; alternatively, narrow the
checklist requirement to match only the behavior the CI step actually tests.
- Around line 76-80: Update both local sdist smoke instructions in the release
checklist to create a fresh isolated environment using the CI uv venv pattern,
then run the smoke interpreter from outside the repository so checkout files
cannot shadow the installed distribution; retain the existing XY_REQUIRE_CARGO=1
installation behavior.
- Around line 162-171: Update the temporary-directory initialization in the
release smoke-test commands to use the portable ${TMPDIR:-/tmp} base path
instead of the macOS-specific /private/tmp path, while preserving the existing
unique directory suffix and subsequent UV_CACHE_DIR and virtual-environment
usage.
- Around line 67-74: Update the release workflow’s Rust installation
configuration to use a genuine SHA checksum for the release-tool Rust version
instead of the current tag-only value, while preserving the action’s commit-SHA
pin. If a verified checksum cannot be provided, remove the checksum field and
document the Rust version used by the release workflow.
- Around line 78-80: Update both local sdist installation examples in the
release checklist to install numpy, anywidget, and reflex>=0.9.6 alongside the
archive, matching the CI setup before running reflex_xy smoke checks. Preserve
the existing XY_REQUIRE_CARGO=1 variant and apply the dependency additions to
both commands.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 567c0df6-342e-4844-94f4-0acd7771afa4

📥 Commits

Reviewing files that changed from the base of the PR and between b3e2605 and 48c934b.

📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • spec/process/production-readiness.md
  • spec/process/release-checklist.md

Comment thread spec/process/release-checklist.md
Comment thread spec/process/release-checklist.md
Comment thread spec/process/release-checklist.md
Comment thread spec/process/release-checklist.md Outdated
Comment thread spec/process/release-checklist.md

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 3 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread spec/process/release-checklist.md Outdated
Comment thread spec/process/release-checklist.md Outdated
Comment thread spec/process/release-checklist.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant